-
Notifications
You must be signed in to change notification settings - Fork 6k
Added a more complete docstring for SemanticsFlags #19817
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
// Must match the SemanticsFlags enum in semantics.dart. | ||
/// C/C++ representation of `SemanticsFlags` defined in | ||
/// `lib/ui/semantics.dart`. | ||
///\warning This must match the `SemanticsFlags` enum in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what does \
do ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's doxygen commands which is what we use for c/c++/objc documentation: https://www.doxygen.nl/manual/commands.html
/// | ||
/// \warning When changes are made to this class, the equivalent APIs in | ||
/// `lib/ui/semantics/semantics_node.h` and in each of the embedders | ||
/// *must* be updated. | ||
/// See also: | ||
/// - file://./../../lib/ui/semantics/semantics_node.h |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks like this didn't do what we hoped:
https://master-api.flutter.dev/flutter/dart-ui/SemanticsAction-class.html
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
filed flutter/flutter#94494
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple of years later... #52229
Description
Related Issues
Tests
Checklist
Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (
[x]
). This will ensure a smooth and quick review process.Breaking Change
Did any tests fail when you ran them? Please read handling breaking changes.